Show:

ia.GradientLegend Class

Extends ia.EventDispatcher
Defined in: ia\ui\GradientLegend.js:1
Module: ia

A class for rendering a gradient legend.

Constructor

ia.GradientLegend

(
  • id
)

Defined in ia\ui\GradientLegend.js:1

Parameters:

  • id String

    The id of the the legend.

Methods

_build

(
  • cw
  • ch
)
private

Defined in ia\ui\GradientLegend.js:98

Builds the legend.

Parameters:

  • cw Number

    The width.

  • ch Number

    The height.

_highlightBlock

(
  • value
)
private

Defined in ia\ui\GradientLegend.js:253

Highlights the block legend

Parameters:

  • value Number

    The value of the item.

_highlightPoint

(
  • value
)
private

Defined in ia\ui\GradientLegend.js:276

Highlights the point legend.

Parameters:

  • value Number

    The value of the item.

_renderBlock

() private

Defined in ia\ui\GradientLegend.js:161

Renders the block legend.

_renderPoint

() private

Defined in ia\ui\GradientLegend.js:186

Renders the point legend.

addEventListener

(
  • eventType
  • fnc
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:15

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

clearHighlight

()

Defined in ia\ui\GradientLegend.js:302

Clears all highlights.

clearSelection

()

Defined in ia\ui\GradientLegend.js:330

Clears all selections.

dispatchEvent

(
  • event
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:50

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

hide

()

Defined in ia\ui\GradientLegend.js:337

Hides the legend.

highlight

(
  • id
)

Defined in ia\ui\GradientLegend.js:230

Highlights the legend.

Parameters:

  • id String

    The id of the item.

removeListener

(
  • obj
)

Inherited from ia.EventDispatcher: ia\events\EventDispatcher.js:30

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

render

()

Defined in ia\ui\GradientLegend.js:77

Renders the legend.

select

(
  • id
)

Defined in ia\ui\GradientLegend.js:314

Selects.

Parameters:

  • id String

    The id of the item.

show

()

Defined in ia\ui\GradientLegend.js:347

Shows the legend.

unselect

(
  • id
)

Defined in ia\ui\GradientLegend.js:322

Unselects.

Parameters:

  • id String

    The id of the item.

Properties

container

JQUERY Element

Defined in ia\ui\GradientLegend.js:69

The container that holds the object.

highlightColor

String

Defined in ia\ui\GradientLegend.js:61

The item highlight color.

id

String

Defined in ia\ui\GradientLegend.js:36

The id.

style

Object

Defined in ia\ui\GradientLegend.js:44

The style.

Default: {fillStyle:'#EFEFEF', strokeStyle:'#cccccc', lineWidth:'0.5', lineJoin:'miter'}

thematic

ia.Thematic

Defined in ia\ui\GradientLegend.js:53

A thematic that can be associated with the data in the legend.